Carbon


SoundComponentPauseSource

Header: Sound.h Carbon status: Supported

Pauses the playing of sounds in one or more sound channels. A sound output device component must implement the SoundComponentPauseSource function.

ComponentResult SoundComponentPauseSource (
    ComponentInstance ti, 
    SInt16 count, 
    SoundSource *sources
);
Parameter descriptions
ti

A component instance that identifies your sound component.

count

The number of source IDs in the array pointed to by the source parameter.

sources

An array of source IDs.

function result

Returns noErr if successful or an appropriate result code otherwise. You should return noErr even if no sounds are playing in the specified channels.

DISCUSSION

Your SoundComponentPauseSource function is called by the Sound Manager to pause the playing of the sounds originating from the sound sources specified by the sources parameter. Your function should stop sending data from those sources to the associated sound output device. Because your SoundComponentStartSource function might be called to resume playing sounds, you should not flush any data. If your component supports only one sound source, you can ignore the sources parameter.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)